CHANGE: docs tools update - #2460
Conversation
![u-pr[bot]](https://avatars.githubusercontent.com/in/1201017?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Harness Review
The recipe source update is directionally fine, but the checked-in Yamato configuration has not been regenerated, so the CI jobs this repository actually runs still use the old docs tooling.
The recipe changes here do not take effect until the generated .yamato/input-system-*.yml files are refreshed and committed. The checked-in job definitions that Yamato consumes still contain the old commands (git clone --branch "2.3.0-preview" ... everywhere, plus %GSUDO% choco install netfx-4.7.1-devpack ... on Windows; see .yamato/input-system-editor-functional-tests.yml / .yamato/input-system-standalone-functional-tests.yml), and .yamato/triggers.yml points at those generated files directly. As committed, this PR will merge without actually switching CI to PMDT 3.14 or installing DocFX 2.70 anywhere. Please regenerate the job YAML and include the updated .yamato/input-system-*.yml outputs in the PR.
Reviewed commit 7efc128
🤖 Helpful? 👍/👎
Codecov ReportAll modified and coverable lines are covered by tests ✅ @@ Coverage Diff @@
## develop #2460 +/- ##
========================================
Coverage 78.95% 78.96%
========================================
Files 767 767
Lines 140780 140833 +53
========================================
+ Hits 111153 111208 +55
+ Misses 29627 29625 -2 Flags with carried forward coverage won't be shown. Click here to find out more.
|
jfreire-unity
left a comment
jfreire-unity
left a comment
There was a problem hiding this comment.
The change looks like it upgrades the PMDT but CI still fails, so we should circle back to the docs engineering team and let us know it's not fixing the problem.
Also, have you tried locally if this change generates the documentation?
| // dotnet SDK availability: confirmed present on package-ci images (Windows, Mac, and Ubuntu) via | ||
| // #devs-pets / #devs-ci Slack history - it's a centrally maintained, version-pinned component of | ||
| // the image family (e.g. package-ci/ubuntu-22.04:v4 SDK version pinning discussion, and a Windows | ||
| // package-ci job observed spawning a .NET 8 subprocess), not something jobs install themselves. | ||
| // So no extra .NET SDK install step is needed here. | ||
| // | ||
| // NuGet source reachability - `dotnet tool install` needs to resolve the docfx package from a feed. | ||
| // There's no nuget.config at the repo root (only Tools/CI/nuget.config, which NuGet won't discover | ||
| // from here since it only walks upward from the working directory), so we pin --add-source | ||
| // explicitly below to Unity's internal Artifactory NuGet proxy - the same source Tools/CI/nuget.config | ||
| // uses, and one we know CI agents can already reach since the recipe-regeneration job restores | ||
| // packages through it. Default sources (nuget.org) are likely unreachable from these locked-down | ||
| // build agents. Still worth confirming on the first real CI run that Artifactory actually mirrors | ||
| // the "docfx" package specifically (vs. only packages requested before). |
There was a problem hiding this comment.
Do we need all this comments? Some parts read as something to be confirmed
2 participants
Description
Upgrading docs package tools. DocFX is no longer part of the package and needs to be installed separately.
Testing status & QA
None.
Overall Product Risks
Comments to reviewers
Checklist
Before review:
Changed,Fixed,Addedsections.Area_CanDoX,Area_CanDoX_EvenIfYIsTheCase,Area_WhenIDoX_AndYHappens_ThisIsTheResult.During merge:
NEW: ___.FIX: ___.DOCS: ___.CHANGE: ___.RELEASE: 1.1.0-preview.3.